Skip to content

docs: remove duplicate local public documentation - #11

Open
CompleteDotTech wants to merge 9 commits into
mainfrom
agent/issue-776-docs-remove-duplicate-local-public-documentation
Open

docs: remove duplicate local public documentation#11
CompleteDotTech wants to merge 9 commits into
mainfrom
agent/issue-776-docs-remove-duplicate-local-public-documentation

Conversation

@CompleteDotTech

Copy link
Copy Markdown
Owner

Summary

  • Replace 22 duplicate local public pages under docs/install/ and docs/start/ with stable pointers to their canonical docs.opencoven.ai routes (guide/install, guide/platforms, guide/deployments, guide/getting-started, cli/install-debugging, cli/uninstall, cli/doctor, daemon/configuration).
  • Shrink README.md from an 867-line second manual to a concise landing page: what Coven is, one install + quick-start path, canonical links, the source-adjacent ownership table, contributor rules, and security posture.
  • Codify the source-adjacent ownership boundary in docs/DOCS-MAINTENANCE.md: public-doc directories may contain only canonical pointers or exceptions that state their source-adjacent ownership reason; docs/index.md links to the rule.
  • Fix root-absolute links in the retained legacy-TUI page (docs/start/coven-tui.md) to the local session-lifecycle contract and the canonical CLI reference.

Audit (what changed and what deliberately did not)

Canonical coverage was verified in OpenCoven/coven-docs before any page was reduced:

Local pages Canonical target (verified merged) Disposition
docs/install/{index,npm,cargo,from-source}.md /docs/guide/install pointer
docs/install/{docker,podman,headless-server,launchd,systemd,nix}.md /docs/guide/deployments pointer
docs/install/{macos,linux,windows,wsl2,raspberry-pi}.md /docs/guide/platforms pointer
docs/install/coven-home.md /docs/daemon/configuration pointer (normative layout contract retained at docs/daemon/coven-home.md)
docs/install/uninstall.md /docs/cli/uninstall pointer
docs/install/updating.md /docs/cli/install-debugging pointer
docs/start/{quickstart,first-session,onboarding,showcase}.md /docs/guide/getting-started pointer
docs/start/doctor.md /docs/cli/doctor pointer

Deliberately unchanged in this docs-only PR:

  • docs/install/development-channels.md — no canonical page covers pre-release channels yet; the local page stays until the canonical target lands.
  • docs/platforms/*.md — canonical /docs/guide/platforms exists, but converting them requires migrating scripts/onboarding-docs-test.mjs to canonical-pointer expectations first (a non-docs commit, per the Wave A plan's ordered guard migration).
  • docs/help/**, docs/harnesses/**, docs/models/** — Wave B canonical targets (reference/support, memory-models/memory-import) are not merged yet.
  • docs/daemon/**, docs/guides/**, docs/reference/api* — Wave C canonical targets (daemon/health, guide/automation-json) are not merged yet.

Remaining follow-ups: the platform-page pointer conversion + guard migration and a CI guard that fails when public-doc directories gain unapproved pages (the "enforced by CI" acceptance item on the umbrella issue).

Issue

Refs OpenCoven#776

Test plan

  • node scripts/onboarding-docs-test.mjs — 16/16 pass
  • node scripts/cli-docs-test.mjs — 7/7 pass
  • python scripts/check-api-contract-docs.py — pass
  • python scripts/check-secrets.py — pass
  • python scripts/check-coven-privacy.py --staged — pass
  • git diff --check — clean; diff classified docs_only by scripts/classify-ci-changes.py
  • cargo fmt/clippy/test — deferred to CI (no Rust toolchain locally); untouched by this docs-only diff

Vehicle note: opened in the fork CompleteDotTech/coven as the CI vehicle — this token cannot write to OpenCoven/coven. Re-target upstream once write access is restored. Refs OpenCoven#776.

@CompleteDotTech CompleteDotTech self-assigned this Aug 30, 2026
@CompleteDotTech
CompleteDotTech marked this pull request as ready for review August 30, 2026 15:54
@CompleteDotTech

Copy link
Copy Markdown
Owner Author

CI provenance note: the PR was opened before Actions was enabled on this fork, so no workflow run was created for the original head SHA (5d087ad's parent). Actions were then enabled via the repository settings API and an empty signed commit (ci: retrigger pull request checks after enabling fork Actions) fired the pull_request: synchronize event. The full docs-only matrix ran and is green: Classify changes ✅, Policy guard ✅, PR gate ✅; Rust/npm/engine/AFS lanes correctly skipped via scripts/classify-ci-changes.py (docs_only=true).

…854) (OpenCoven#861)

Adds one dated status/decision record for issue OpenCoven#854 in docs/superpowers/plans/.

Independently verified against main @ 1364cec (2026-08-30): the coven#816
foundation series (PR OpenCoven#846, PR OpenCoven#847, parts 6-8 commits) landed the durable
local scheduler core - definitions, SQLite definition/occurrence/run records
with unique occurrence fencing, RRULE planning, bounded leases with expiry
recovery, latest-only misfire / overlap refusal, the 60s daemon tick with
scheduled dispatch, shared launch path, health and run history,
non-destructive paused legacy import, and coven.automations.* control
actions. Records what is still absent for v1 (versioned protocol schemas,
authority/receipt binding, deterministic-time contract, SDK surface,
conformance/chaos/SLO gates, live Beads mutation), the gate-by-gate verdict,
and the critical path. The program issue remains open; this record closes
no issue.

Refs OpenCoven#854.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
…oven#815) (OpenCoven#871)

* docs: plan cryptographic fresh-user and biometric assurance proofs (coven#815)

Specify COVEN-ASSURANCE/1, an independently verifiable step-up proof so
request authentication can satisfy FreshUserVerification/FreshBiometric
grant requirements without trusting client-asserted assurance levels.

The plan defines: possession/step-up key separation; binding the optional
step-up authorization key and its declared assurance class into the
pairing-v2 transcript; a separate authorization-key store; canonical
proof bytes over device, grant, revocation epoch, exact request or
DeviceActionIntent digest, server-issued single-use challenge, window,
and requested assurance; server-side effective assurance computed as
min(claimed, class ceiling) and passed to DeviceGrant::authorize;
fail-closed possession-only degradation; rotation/revocation semantics;
iOS/Android platform mapping; a self-verifying synthetic golden vector;
and TypeScript/JSON Schema for implementers. Every claim cites the
current mobile_memory code path it builds on.

No code changes: this is the design artifact the issue asks for.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>

* docs(mobile): specify COVEN-ASSURANCE/1 step-up assurance proofs

Add docs/design/mobile-assurance-step-up-v1.md, the plan and
implementation contract for issue OpenCoven#815: a separately enrolled,
platform-policy-protected step-up authorization key, bound into the
pairing-v2 transcript before grant issuance, whose fresh signatures
over canonical COVEN-ASSURANCE/1 bytes (device, grant, revocation
epoch, exact request or DeviceActionIntent digest, single-use server
challenge, validity window, requested assurance) are the only way to
raise assurance above possession. The server verifies the signature,
computes effective assurance itself, and passes it to
DeviceGrant::authorize; absent/invalid/expired/replayed proofs fail
closed. Covers storage separate from the possession key, replay
protection independent of request nonces, rotation/revocation
semantics, iOS/Android key-policy mapping, a security-invariant
mapping, TypeScript types + JSON Schema, and a portable golden vector.
Design artifact only; no behavior change.

Refs OpenCoven#815

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>

---------

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
…heck (coven#859) (OpenCoven#862)

Establish the GitHub-side half of the OpenCoven#859 operational delivery graph:

- docs/roadmaps/coven-automations-v1.md: program roadmap with canonical
  tracker roles, sync metadata, P0/P1/P2 policy, generated outcome-mapping
  table, dependency graph, release gates, active blockers, and drift
  detection usage. The mapping table block is generated by
  docs/roadmaps/drift-check.mjs --render and verified on every run.
- docs/roadmaps/coven-automations-v1.mapping.json: machine-readable
  one-to-one Bead <-> GitHub mapping for OpenCoven#854, OpenCoven#816, OpenCoven#855, OpenCoven#856, OpenCoven#857,
  and OpenCoven#858, with explicit dependencies, acceptance gates, dispositions,
  and evidence links. Bead IDs stay null (warn-level W010) until
  provisioning lands through OpenCoven/coven-cave#5220 per the
  operational correction on OpenCoven#859; no competing Beads store is created
  in this repository.
- docs/roadmaps/drift-check.mjs: credential-free, offline drift check
  covering state, priority, parent/dependency, evidence, generated-mirror,
  duplicate/missing mapping, cycle, and sensitive-payload drift classes,
  with --beads-export cross-checking and --selftest proving detection.
- docs/superpowers/plans/2026-08-30-issue-859-coven-automations-v1-...md:
  dated status/decision record: what exists on main (automations series
  landed 2026-08-28 via PRs OpenCoven#846/OpenCoven#847), pre-change integrity report,
  decisions D1-D7, verdict against the OpenCoven#859 acceptance criteria,
  remaining work, critical path, and the initial evidence packet.

Refs OpenCoven#859



fix: keep automation tracker docs scanner-safe

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
@CompleteDotTech
CompleteDotTech force-pushed the agent/issue-776-docs-remove-duplicate-local-public-documentation branch from b917112 to d184a4d Compare August 30, 2026 17:47
… claims

* docs: consolidate Coven security policy, threat boundary, and support claims

Replace the duplicated SECURITY.md (repository policy plus a copied
organization-wide disclosure addendum) with one Coven-specific operational
security contract that visibly separates:

- supported release family and security-supported surfaces, with
  experimental/disabled surfaces (AFS mount backend, OpenClaw plugin,
  remote transports) marked explicitly;
- enforced properties today, each tied to its normative contract and
  verification family (Rust authority checks, capability advertisement,
  pre-effect validation, owner-protected local transport, redaction and
  artifact defaults, secret/privacy guards, explicit mutation replay);
- residual risk and safe configuration (same-user trust vs sandboxing,
  raw-artifact opt-in, retention limits, untrusted harnesses, AgentFS
  mount posture synced with OpenCoven#779);
- private reporting via GitHub Security Advisories as the primary path,
  with no personal-channel dependency and no unsupported response-time
  commitment, plus scoped third-party dependency/provider handling;
- design goals (session/memory/agent isolation) moved out of guarantees,
  cross-referencing OpenCoven#803/OpenCoven#804 instead of claiming unimplemented A2A
  isolation.

Removes the stale OpenTrust-scope addendum, the personal Discord DM
reporting path, and the 48-hour/14-day response promises that no
accountable process currently backs.

Refs OpenCoven#808

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>

* fix: document tokenized invite URL privacy rule

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>

---------

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
@CompleteDotTech
CompleteDotTech force-pushed the agent/issue-776-docs-remove-duplicate-local-public-documentation branch from d184a4d to d8d3e4a Compare August 30, 2026 17:49
CompleteDotTech and others added 5 commits August 30, 2026 17:52
…enCoven#785) (OpenCoven#867)

* docs(pairing): plan TUI QR bootstrap and E2EE mobile pairing (refs OpenCoven#785)

Add the implementation plan for issue OpenCoven#785: the coven device command
family, canonical CBOR pairing offer with Universal Link encoding,
Noise_XK handshake with QR-pinned host authentication, rendezvous relay
MVP on coven-relay, six-word human verification derived from the
handshake hash, scope selection and capability binding, the adversarial
test matrix, and the maintainer decision points.

Extends the accepted mobile-device-trust architecture and elaborates
PR 3 + the rendezvous slice of PR 4 of the pairing delivery train.
Docs-only change; cross-links the delivery plan to the new plan.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>

* chore(pairing): retrigger CI for the plan PR (no content change)

The pull_request opened event raced the fork's lazy workflow
registration, so no run was created. This empty commit re-emits the
synchronize event; it changes no content.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>

---------

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
The canonical install, platform, deployment, uninstall, and install-debugging guides are merged in OpenCoven/coven-docs, so the duplicate local pages under docs/install/ become stable pointers per the Wave A cleanup plan. docs/install/development-channels.md keeps its local content because no canonical page covers pre-release channels yet.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
Duplicate local onboarding pages (quickstart, first session, onboarding, showcase, doctor) become pointers to the canonical getting-started and doctor routes. coven-tui.md keeps its legacy-TUI contract and its root-absolute links are fixed to the retained local session-lifecycle contract and the canonical CLI reference.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
…boundary

The README stops duplicating the canonical manual and keeps the landing-page facts: what Coven is, one install and quick-start path, canonical links, the source-adjacent ownership table, contributor rules, and security. DOCS-MAINTENANCE.md gains the enforceable public-doc directory boundary (canonical pointers or source-adjacent exceptions with stated ownership reasons), and docs/index.md links to it.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
No file changes. The pull request was opened before Actions was enabled on this fork, so no workflow run was created for its head SHA. This empty commit fires a pull_request synchronize event so the CI matrix can report.

Signed-off-by: Timothy Wayne Gregg <5861166+CompleteDotTech@users.noreply.github.com>
@CompleteDotTech
CompleteDotTech force-pushed the agent/issue-776-docs-remove-duplicate-local-public-documentation branch from d8d3e4a to a1d0ec7 Compare August 30, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant